home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / os2 / octa209s.zip / octave-2.09 / libs / info / info.c < prev    next >
C/C++ Source or Header  |  1997-08-14  |  17KB  |  547 lines
  1. /* info.c -- Display nodes of Info files in multiple windows. */
  2. /* Changed for emx by Kai Uwe Rommel & Eberhard Mattes -- Nov 1995 */
  3. /* Changed by Klaus Gebhardt -- May 1994, March 1996 */
  4.  
  5. /* This file is part of GNU Info, a program for reading online documentation
  6.    stored in Info format.
  7.  
  8.    Copyright (C) 1993 Free Software Foundation, Inc.
  9.  
  10.    This program is free software; you can redistribute it and/or modify
  11.    it under the terms of the GNU General Public License as published by
  12.    the Free Software Foundation; either version 2, or (at your option)
  13.    any later version.
  14.  
  15.    This program is distributed in the hope that it will be useful,
  16.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18.    GNU General Public License for more details.
  19.  
  20.    You should have received a copy of the GNU General Public License
  21.    along with this program; if not, write to the Free Software
  22.    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23.  
  24.    Written by Brian Fox (bfox@ai.mit.edu). */
  25.  
  26. #include "info.h"
  27. #include "dribble.h"
  28. #include "terminal.h"
  29. #include "getopt.h"
  30. #if defined (HANDLE_MAN_PAGES)
  31. #  include "man.h"
  32. #endif /* HANDLE_MAN_PAGES */
  33.  
  34. /* The version numbers of this version of Info. */
  35. int info_major_version = 2;
  36. int info_minor_version = 14;
  37. int info_patch_level = 0;
  38.  
  39. /* Non-zero means search all indices for APROPOS_SEARCH_STRING. */
  40. static int apropos_p = 0;
  41.  
  42. /* Variable containing the string to search for when apropos_p is non-zero. */
  43. static char *apropos_search_string = (char *)NULL;
  44.  
  45. /* Non-zero means search all indices for INDEX_SEARCH_STRING.  Unlike
  46.    apropos, this puts the user at the node, running info. */
  47. static int index_search_p = 0;
  48.  
  49. /* Variable containing the string to search for when index_search_p is
  50.    non-zero. */
  51. static char *index_search_string = (char *)NULL;
  52.  
  53. /* Non-zero means print version info only. */
  54. static int print_version_p = 0;
  55.  
  56. /* Non-zero means print a short description of the options. */
  57. static int print_help_p = 0;
  58.  
  59. /* Array of the names of nodes that the user specified with "--node" on the
  60.    command line. */
  61. static char **user_nodenames = (char **)NULL;
  62. static int user_nodenames_index = 0;
  63. static int user_nodenames_slots = 0;
  64.  
  65. /* String specifying the first file to load.  This string can only be set
  66.    by the user specifying "--file" on the command line. */
  67. static char *user_filename = (char *)NULL;
  68.  
  69. /* String specifying the name of the file to dump nodes to.  This value is
  70.    filled if the user speficies "--output" on the command line. */
  71. static char *user_output_filename = (char *)NULL;
  72.  
  73. /* Non-zero indicates that when "--output" is specified, all of the menu
  74.    items of the specified nodes (and their subnodes as well) should be
  75.    dumped in the order encountered.  This basically can print a book. */
  76. int dump_subnodes = 0;
  77.  
  78. /* Structure describing the options that Info accepts.  We pass this structure
  79.    to getopt_long ().  If you add or otherwise change this structure, you must
  80.    also change the string which follows it. */
  81. #define APROPOS_OPTION 1
  82. #define DRIBBLE_OPTION 2
  83. #define RESTORE_OPTION 3
  84. #define IDXSRCH_OPTION 4
  85. static struct option long_options[] = {
  86.   { "apropos", 1, 0, APROPOS_OPTION },
  87.   { "directory", 1, 0, 'd' },
  88.   { "node", 1, 0, 'n' },
  89.   { "file", 1, 0, 'f' },
  90.   { "subnodes", 0, &dump_subnodes, 1 },
  91.   { "output", 1, 0, 'o' },
  92.   { "help", 0, &print_help_p, 1 },
  93.   { "version", 0, &print_version_p, 1 },
  94.   { "dribble", 1, 0, DRIBBLE_OPTION },
  95.   { "restore", 1, 0, RESTORE_OPTION },
  96.   { "index-search", 1, 0, IDXSRCH_OPTION },
  97.   {NULL, 0, NULL, 0}
  98. };
  99.  
  100. /* String describing the shorthand versions of the long options found above. */
  101. #ifdef EMX
  102. static char *short_options = "d:n:f:o:sh?";
  103. #else /* !EMX */
  104. static char *short_options = "d:n:f:o:s";
  105. #endif /* !EMX */
  106.  
  107. /* When non-zero, the Info window system has been initialized. */
  108. int info_windows_initialized_p = 0;
  109.  
  110. /* Some "forward" declarations. */
  111. static void usage (), info_short_help (), remember_info_program_name ();
  112. char *program_name = (char *)NULL;
  113.  
  114.  
  115. /* **************************************************************** */
  116. /*                                    */
  117. /*          Main Entry Point to the Info Program            */
  118. /*                                    */
  119. /* **************************************************************** */
  120.  
  121. int
  122. main (argc, argv)
  123.      int argc;
  124.      char **argv;
  125. {
  126.   int getopt_long_index;    /* Index returned by getopt_long (). */
  127.   NODE *initial_node;        /* First node loaded by Info. */
  128.  
  129.   remember_info_program_name (argv[0]);
  130. #ifdef EMX
  131.   setvbuf(stdout, NULL, _IOFBF, BUFSIZ);
  132. #endif /* EMX */
  133.  
  134.   while (1)
  135.     {
  136.       int option_character;
  137.  
  138.       option_character = getopt_long
  139.     (argc, argv, short_options, long_options, &getopt_long_index);
  140.  
  141.       /* getopt_long () returns EOF when there are no more long options. */
  142.       if (option_character == EOF)
  143.     break;
  144.  
  145.       /* If this is a long option, then get the short version of it. */
  146.       if (option_character == 0 && long_options[getopt_long_index].flag == 0)
  147.     option_character = long_options[getopt_long_index].val;
  148.  
  149.       /* Case on the option that we have received. */
  150.       switch (option_character)
  151.     {
  152.     case 0:
  153.       break;
  154.  
  155.       /* User wants to add a directory. */
  156.     case 'd':
  157.       info_add_path (optarg, INFOPATH_PREPEND);
  158.       break;
  159.  
  160.       /* User is specifying a particular node. */
  161.     case 'n':
  162.       add_pointer_to_array (optarg, user_nodenames_index, user_nodenames,
  163.                 user_nodenames_slots, 10, char *);
  164.       break;
  165.  
  166.       /* User is specifying a particular Info file. */
  167.     case 'f':
  168.       if (user_filename)
  169.         free (user_filename);
  170.  
  171.       user_filename = strdup (optarg);
  172.       break;
  173.  
  174. #ifdef EMX
  175.       /* User is requesting help. */
  176.     case 'h':
  177.       print_help_p = 1;
  178.       break;
  179. #endif /* EMX */
  180.  
  181.       /* User is specifying the name of a file to output to. */
  182.     case 'o':
  183.       if (user_output_filename)
  184.         free (user_output_filename);
  185.       user_output_filename = strdup (optarg);
  186.       break;
  187.  
  188.       /* User is specifying that she wishes to dump the subnodes of
  189.          the node that she is dumping. */
  190.     case 's':
  191.       dump_subnodes = 1;
  192.       break;
  193.  
  194.       /* User has specified a string to search all indices for. */
  195.     case APROPOS_OPTION:
  196.       apropos_p = 1;
  197.       maybe_free (apropos_search_string);
  198.       apropos_search_string = strdup (optarg);
  199.       break;
  200.  
  201.       /* User has specified a dribble file to receive keystrokes. */
  202.     case DRIBBLE_OPTION:
  203.       close_dribble_file ();
  204.       open_dribble_file (optarg);
  205.       break;
  206.  
  207.       /* User has specified an alternate input stream. */
  208.     case RESTORE_OPTION:
  209.       info_set_input_from_file (optarg);
  210.       break;
  211.  
  212.       /* User has specified a string to search all indices for. */
  213.     case IDXSRCH_OPTION:
  214.       index_search_p = 1;
  215.       maybe_free (index_search_string);
  216.       index_search_string = strdup (optarg);
  217.       break;
  218.  
  219.     default:
  220.       usage ();
  221.     }
  222.     }
  223.  
  224.   /* If the output device is not a terminal, and no output filename has been
  225.      specified, make user_output_filename be "-", so that the info is written
  226.      to stdout, and turn on the dumping of subnodes. */
  227.   if ((!isatty (fileno (stdout))) && (user_output_filename == (char *)NULL))
  228.     {
  229.       user_output_filename = strdup ("-");
  230.       dump_subnodes = 1;
  231.     }
  232.  
  233.   /* If the user specified --version, then show the version and exit. */
  234.   if (print_version_p)
  235.     {
  236.       printf ("GNU Info, Version %s.\n", version_string ());
  237.       exit (0);
  238.     }
  239.  
  240.   /* If the `--help' option was present, show the help and exit. */
  241.   if (print_help_p)
  242.     {
  243.       info_short_help ();
  244.       exit (0);
  245.     }
  246.   
  247.   /* If the user hasn't specified a path for Info files, default that path
  248.      now. */
  249.   if (!infopath)
  250.     {
  251.       char *path_from_env, *getenv ();
  252.  
  253.       path_from_env = getenv ("INFOPATH");
  254.  
  255.       if (path_from_env)
  256.     info_add_path (path_from_env, INFOPATH_PREPEND);
  257.       else
  258.     info_add_path (DEFAULT_INFOPATH, INFOPATH_PREPEND);
  259.     }
  260.  
  261.   /* If the user specified a particular filename, add the path of that
  262.      file to the contents of INFOPATH. */
  263.   if (user_filename)
  264.     {
  265.       char *directory_name, *temp;
  266.  
  267.       directory_name = strdup (user_filename);
  268.       temp = filename_non_directory (directory_name);
  269.  
  270.       if (temp != directory_name)
  271.     {
  272.       *temp = 0;
  273.       info_add_path (directory_name, INFOPATH_PREPEND);
  274.     }
  275.  
  276.       free (directory_name);
  277.     }
  278.  
  279.   /* If the user wants to search every known index for a given string,
  280.      do that now, and report the results. */
  281.   if (apropos_p)
  282.     {
  283.       info_apropos (apropos_search_string);
  284.       exit (0);
  285.     }
  286.  
  287.   /* Get the initial Info node.  It is either "(dir)Top", or what the user
  288.      specifed with values in user_filename and user_nodenames. */
  289.   if (user_nodenames)
  290.     initial_node = info_get_node (user_filename, user_nodenames[0]);
  291.   else
  292.     initial_node = info_get_node (user_filename, (char *)NULL);
  293.  
  294.   /* If we couldn't get the initial node, this user is in trouble. */
  295.   if (!initial_node)
  296.     {
  297.       if (info_recent_file_error)
  298.     info_error (info_recent_file_error);
  299.       else
  300.     info_error
  301.       (CANT_FIND_NODE, user_nodenames ? user_nodenames[0] : "Top");
  302.       exit (1);
  303.     }
  304.  
  305.   /* Special cases for when the user specifies multiple nodes.  If we are
  306.      dumping to an output file, dump all of the nodes specified.  Otherwise,
  307.      attempt to create enough windows to handle the nodes that this user wants
  308.      displayed. */
  309.   if (user_nodenames_index > 1)
  310.     {
  311.       free (initial_node);
  312.  
  313.       if (user_output_filename)
  314.     dump_nodes_to_file
  315.       (user_filename, user_nodenames, user_output_filename, dump_subnodes);
  316.       else
  317.     begin_multiple_window_info_session (user_filename, user_nodenames);
  318.  
  319.       exit (0);
  320.     }
  321.  
  322.   /* If the user specified `--index-search string', start the info
  323.      session in the node corresponding to the first match. */
  324.   if (index_search_p)
  325.     {
  326.       int status = external_info_search (initial_node, 0,
  327.                      user_filename, index_search_string);
  328.  
  329.       if (status == 1)
  330.     {
  331.       info_read_and_dispatch ();
  332.       terminal_unprep_terminal ();
  333.       fflush (stdout);
  334.     }
  335.  
  336.       if (status == 0)
  337.     info_error ("%s: Entry not found", index_search_string, NULL);
  338.  
  339.       close_dribble_file ();
  340.  
  341.       terminal_goto_xy (0, screenheight - 2);
  342.       terminal_clear_to_eol ();
  343.       terminal_unprep_terminal ();
  344.  
  345.       exit (status * status - 1);
  346.     }
  347.  
  348.   /* If there are arguments remaining, they are the names of menu items
  349.      in sequential info files starting from the first one loaded.  That
  350.      file name is either "dir", or the contents of user_filename if one
  351.      was specified. */
  352.   while (optind != argc)
  353.     {
  354.       REFERENCE **menu;
  355.       REFERENCE *entry;
  356.       NODE *node;
  357.       char *arg;
  358.       static char *first_arg = (char *)NULL;
  359.  
  360.       /* Remember the name of the menu entry we want. */
  361.       arg = argv[optind++];
  362.  
  363.       if (first_arg == (char *)NULL)
  364.     first_arg = arg;
  365.  
  366.       /* Build and return a list of the menu items in this node. */
  367.       menu = info_menu_of_node (initial_node);
  368.  
  369.       /* If there wasn't a menu item in this node, stop here, but let
  370.      the user continue to use Info.  Perhaps they wanted this node
  371.      and didn't realize it. */
  372.       if (!menu)
  373.     {
  374. #if defined (HANDLE_MAN_PAGES)
  375.       if (first_arg == arg)
  376.         {
  377.           node = make_manpage_node (first_arg);
  378.           if (node)
  379.         goto maybe_got_node;
  380.         }
  381. #endif /* HANDLE_MAN_PAGES */
  382.       begin_info_session_with_error
  383.         (initial_node, "There is no menu in this node.");
  384.       exit (0);
  385.     }
  386.  
  387.       /* Find the specified menu item. */
  388.       entry = info_get_labeled_reference (arg, menu);
  389.  
  390.       /* If the item wasn't found, search the list sloppily.  Perhaps this
  391.      user typed "buffer" when they really meant "Buffers". */
  392.       if (!entry)
  393.     {
  394.       register int i;
  395.  
  396.       for (i = 0; entry = menu[i]; i++)
  397.         if (strncasecmp (entry->label, arg, strlen (arg)) == 0)
  398.           break;
  399.     }
  400.  
  401.       /* If we failed to find the reference, start Info with the current
  402.      node anyway.  It is probably a misspelling. */
  403.       if (!entry)
  404.     {
  405.       char *error_message = "There is no menu item \"%s\" in this node.";
  406.  
  407. #if defined (HANDLE_MAN_PAGES)
  408.       if (first_arg == arg)
  409.         {
  410.           node = make_manpage_node (first_arg);
  411.           if (node)
  412.         goto maybe_got_node;
  413.         }
  414. #endif /* HANDLE_MAN_PAGES */
  415.  
  416.       info_free_references (menu);
  417.  
  418.       /* If we were supposed to dump this node, complain. */
  419.       if (user_output_filename)
  420.         info_error (error_message, arg);
  421.       else
  422.         begin_info_session_with_error (initial_node, error_message, arg);
  423.  
  424.       exit (0);
  425.     }
  426.  
  427.       /* We have found the reference that the user specified.  Clean it
  428.      up a little bit. */
  429.       if (!entry->filename)
  430.     {
  431.       if (initial_node->parent)
  432.         entry->filename = strdup (initial_node->parent);
  433.       else
  434.         entry->filename = strdup (initial_node->filename);
  435.     }
  436.  
  437.       /* Find this node.  If we can find it, then turn the initial_node
  438.      into this one.  If we cannot find it, try using the label of the
  439.      entry as a file (i.e., "(LABEL)Top").  Otherwise the Info file is
  440.      malformed in some way, and we will just use the current value of
  441.      initial node. */
  442.       node = info_get_node (entry->filename, entry->nodename);
  443.  
  444. #if defined (HANDLE_MAN_PAGES)
  445.       if ((first_arg == arg) && !node)
  446.         {
  447.           node = make_manpage_node (first_arg);
  448.           if (node)
  449.         goto maybe_got_node;
  450.         }
  451. #endif /* HANDLE_MAN_PAGES */
  452.  
  453.       if (!node && entry->nodename &&
  454.       (strcmp (entry->label, entry->nodename) == 0))
  455.     node = info_get_node (entry->label, "Top");
  456.  
  457.     maybe_got_node:
  458.       if (node)
  459.     {
  460.       free (initial_node);
  461.       initial_node = node;
  462.       info_free_references (menu);
  463.     }
  464.       else
  465.     {
  466.       char *temp = strdup (entry->label);
  467.       char *error_message;
  468.  
  469.       error_message = "Unable to find the node referenced by \"%s\".";
  470.  
  471.       info_free_references (menu);
  472.  
  473.       /* If we were trying to dump the node, then give up.  Otherwise,
  474.          start the session with an error message. */
  475.       if (user_output_filename)
  476.         info_error (error_message, temp);
  477.       else
  478.         begin_info_session_with_error (initial_node, error_message, temp);
  479.  
  480.       exit (0);
  481.     }
  482.     }
  483.  
  484.   /* If the user specified that this node should be output, then do that
  485.      now.  Otherwise, start the Info session with this node. */
  486.   if (user_output_filename)
  487.     dump_node_to_file (initial_node, user_output_filename, dump_subnodes);
  488.   else
  489.     begin_info_session (initial_node);
  490.  
  491.   exit (0);
  492. }
  493.  
  494. static void
  495. remember_info_program_name (fullpath)
  496.      char *fullpath;
  497. {
  498.   char *filename;
  499.  
  500.   filename = filename_non_directory (fullpath);
  501.   program_name = strdup (filename);
  502. }
  503.  
  504. /* Produce a very brief descripton of the available options and exit with
  505.    an error. */
  506. static void
  507. usage ()
  508. {
  509. #ifdef EMX
  510.   fprintf (stderr,"\nGNU Info, Version %s.\n", version_string ());
  511. #endif /* EMX */
  512.   fprintf (stderr,"%s\n%s\n%s\n%s\n%s\n",
  513. "Usage: info [-d dir-path] [-f info-file] [-o output-file] [-n node-name]...",
  514. "            [--directory dir-path] [--file info-file] [--node node-name]...",
  515. "            [--help] [--output output-file] [--subnodes] [--version]",
  516. "            [--dribble dribble-file] [--restore from-file]",
  517. "            [--index-search string] [menu-selection ...]");
  518.   exit (1);
  519. }
  520.  
  521. /* Produce a scaled down description of the available options to Info. */
  522. static void
  523. info_short_help ()
  524. {
  525.   printf ("%s", "\
  526. Here is a quick description of Info's options.  For a more complete\n\
  527. description of how to use Info, type `info info options'.\n\
  528. \n\
  529.    --directory DIR        Add DIR to INFOPATH.\n\
  530.    --file FILENAME        Specify Info file to visit.\n\
  531.    --index-search STRING        Specify STRING to search for in the index.\n\
  532.    --node NODENAME        Specify nodes in first visited Info file.\n\
  533.    --output FILENAME        Output selected nodes to FILENAME.\n\
  534.    --dribble FILENAME        Remember user keystrokes in FILENAME.\n\
  535.    --restore FILENAME        Read initial keystrokes from FILENAME.\n\
  536.    --subnodes            Recursively output menu items.\n\
  537.    --help            Get this help message.\n\
  538.    --version            Display Info's version information.\n\
  539. \n\
  540. Remaining arguments to Info are treated as the names of menu\n\
  541. items in the initial node visited.  You can easily move to the\n\
  542. node of your choice by specifying the menu names which describe\n\
  543. the path to that node.  For example, `info emacs buffers'.\n");
  544.  
  545.   exit (0);
  546. }
  547.